DiagnosticReport Resource Implementation
Reference: http://hl7.org/fhir/R4/diagnosticreport.html
| Element / Node Names | Description |
|---|
| id | Business identifier for report, usually the filler's order number |
| identifier | Filler's report ID |
| issued | Date and time this version was available in Éclair |
| meta | Meta data about the report including the last updated date & time |
| performer | Responsible Diagnostic Service i.e. the lab that sent the report to Eclair, taken from the sending facility. If the sending facility has been given a name in Eclair, this should be present in the performer as the display text. |
| resourceType | Represents the FHIR domain resource type |
| result | Internal references to the Observation resources |
| serviceRequest | Contains the Requester element with details of the ordering clinician |
| specimen | Specimens this report is based on |
| status | Shows the status of the Diagnostic Report i.e. it could be registered, partial, preliminary, final |
Query Parameters
The following parameters are supported for performing queries on FHIR Patient resource. See http://hl7.org/fhir/R4/searchparameter-registry.html for further information.
| Data | Parameter |
|---|
| Search parameters | Internal patient ID |
| NHI |
| Report ID |
| Test or Procedure code in LOINC or NZPOCs |
| Partial patient name |
| Filter Criteria | Date range |
| 1 or more External Observation codes (Standard test or procedure code e.g. NZPOCS) |
| 1 or more Local Observation code (Local test or procedure code in LOINC) |
| Limit by count | number of resources to be returned |
| Included data | Include Results (Observations) |
| Sort by order of | date, ascending or descending |
Examples by Use Case
| Use Cases | Examples | Notes, Comments |
|---|
| Retrieve 1 Diagnostic Reports by Report ID | GET {{host}}clinicaldocrepo/Eclair/DiagnosticReport/APHDELPHIC%7C17CCNR100000 | |
| Retrieve all diagnostic reports for a given patient | GET https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/DiagnosticReport?patient\.identifier=standards\.digital\.health\.nz%2Fns%2Fnhi\-id%7CZKE5509 | DiagnosticReport can be retrieved from Eclair utilising NHIs and test codes as search parameters |
| Retrieve all Diagnostic Reports for a patient by External Code e.g., LIS_TREE_682. Sort by date; Include Observations | GET https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/DiagnosticReport?patient\.identifier=standards\.digital\.health\.nz%2Fns%2Fnhi\-id%7CZKG6972&\_include:Results&code=LIS\_TREE\_682&\_sort=rdate | Labs don't order diagnostic reports by LOINC code. So use only External Code. |
| Retrieve 1 Diagnostic Reports for a patient, filter by code and sort by date. Include Observations | GET https://reg\-eclairfhir\-api\-v40\-acc\.au\-s1\.cloudhub\.io/clinicaldocrepo/Eclair/DiagnosticReport?patient\.identifier=standards\.digital\.health\.nz%2Fns%2Fnhi\-id%7CZKE5509&\_include:Results&code=1000&\_sort=rdate&\_count=1 | |
Sample Payloads
Request Payload
GET https://reg-eclairfhir-api-v40-acc.au-s1.cloudhub.io/clinicaldocrepo/Eclair/DiagnosticReport?patient.identifier=standards.digital.health.nz/ns/nhi-id%7CZKG6972&code=http://loinc.org%7CLTAFBE&_Rsort=date&_include=Diagnosticreport:result
Response Payload
{
"resourceType": "Bundle",
"meta": {
"lastUpdated": "2023-09-29T12:47:41.4159106+13:00"
},
"type": "searchset",
"entry": [
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/DiagnosticReport/MLS|23-8097008-FBE-0",
"resource": {
"resourceType": "DiagnosticReport",
"meta": {
"versionId": "1",
"lastUpdated": "2023-06-02T13:43:00+12:00"
},
"identifier": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/Dictionaries/ModifyFacilities.asp?FacilityCode=MLS",
"value": "23-8097008-FBE-0"
}
],
"basedOn": [
{
"reference": "f0d84f5d-e092-40ac-a9e8-e4ee22b6fef2"
}
],
"status": "final",
"category": [
{
"coding": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/Dictionaries/ModifyDepartments.asp?ServiceType=D&CurrentService=HM&CurrentServiceFacility=MLS",
"code": "HM",
"display": "HM"
}
]
}
],
"code": {
"coding": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/OrderConfiguration/ModifyObservations.asp?ObscObsid=LTAFBE&ObscObsidSch=20206",
"code": "LTAFBE",
"display": "COMPLETE BLOOD COUNT"
}
]
},
"subject": {
"reference": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Patient/NHI|ZKG6972"
},
"effectiveDateTime": "2023-06-02T10:36:00+12:00",
"issued": "2023-09-29T12:47:00+13:00",
"performer": [
{
"reference": "MLS",
"display": "Medlab South"
}
],
"result": [
{
"reference": "urn:uuid:05b08fb2-c220-4824-8147-856cde6f1dbd",
"display": "Haemoglobin"
},
{
"reference": "urn:uuid:a69ddc03-8f23-43ab-b180-101d32ee5a03",
"display": "RBC"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Practitioner/20208|THSA6",
"resource": {
"resourceType": "Practitioner",
"id": "b1090b65-cdfc-47d2-8ed8-c5a318572121",
"identifier": [
{
"use": "usual",
"system": "20208",
"value": "THSA6"
}
],
"name": [
{
"use": "official",
"family": "THOMPSON, Sarah"
}
]
}
},
{
"resource": {
"resourceType": "ServiceRequest",
"id": "f0d84f5d-e092-40ac-a9e8-e4ee22b6fef2",
"requester": {
"reference": "b1090b65-cdfc-47d2-8ed8-c5a318572121"
}
}
},
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Observation/MLS|23-8097008-FBE-0|718-7",
"resource": {
"resourceType": "Observation",
"id": "05b08fb2-c220-4824-8147-856cde6f1dbd",
"meta": {
"lastUpdated": "2023-06-02T13:43:00+12:00"
},
"status": "final",
"code": {
"coding": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/OrderConfiguration/ModifyObservations.asp?ObscObsid=718-7&ObscObsidSch=20206",
"code": "718-7",
"display": "Haemoglobin"
},
{
"system": "http://loinc.org/718-7",
"code": "718-7",
"display": "Haemoglobin"
}
]
},
"subject": {
"reference": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Patient/NHI|ZKG6972"
},
"effectiveDateTime": "2023-06-02T10:36:00+12:00",
"issued": "2023-06-02T13:43:00+12:00",
"performer": [
{
"reference": "MLS",
"display": "Medlab South"
}
],
"valueQuantity": {
"value": 154.0,
"unit": "g/L"
},
"interpretation": [
{
"coding": [
{
"system": "http://hl7.org/fhir/ValueSet/observation-interpretation",
"code": "N"
}
],
"text": "Normal"
}
],
"referenceRange": [
{
"text": "130 - 175"
}
]
}
},
{
"fullUrl": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Observation/MLS|23-8097008-FBE-0|26453-1",
"resource": {
"resourceType": "Observation",
"id": "a69ddc03-8f23-43ab-b180-101d32ee5a03",
"meta": {
"lastUpdated": "2023-06-02T13:43:00+12:00"
},
"status": "final",
"code": {
"coding": [
{
"system": "https://eclair.hanz.health.nz/Eclair/Admin/OrderConfiguration/ModifyObservations.asp?ObscObsid=26453-1&ObscObsidSch=20206",
"code": "26453-1",
"display": "RBC"
},
{
"system": "http://loinc.org/26453-1",
"code": "26453-1",
"display": "RBC"
}
]
},
"subject": {
"reference": "https://eclair-api-acc.hanz.health.nz/EclairResourceServer/Eclair/Patient/NHI|ZKG6972"
},
"effectiveDateTime": "2023-06-02T10:36:00+12:00",
"issued": "2023-06-02T13:43:00+12:00",
"performer": [
{
"reference": "MLS",
"display": "Medlab South"
}
],
"valueQuantity": {
"value": 5.05,
"unit": "x10^12/L"
},
"interpretation": [
{
"coding": [
{
"system": "http://hl7.org/fhir/ValueSet/observation-interpretation",
"code": "N"
}
],
"text": "Normal"
}
],
"referenceRange": [
{
"text": "4.30 - 6.00"
}
]
}
}
]
}